Make Client object globally available #1043

basepi · 2021-02-10T18:22:30Z

What does this pull request do?

Managing the Client object has always been a bit of a pain. Most of the time passing around the Client via the framework's application objects works ok. But as we move into supporting more instrumentations that require creating transactions (like Kafka), getting the client object becomes more of a pain.

The idea behind this (unfinished) PR is to painlessly save the Client object when it is created, and provide elasticapm.get_client() to make it easy to get that Client object from anywhere.

If we decide this is a good idea, the next step is to remove all of the framework-specific scaffolding around the Client object and use this new elasticapm.get_client() everywhere.

@beniwohli thoughts?

apmmachine · 2021-02-10T18:47:24Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Build Cause: Started by user Colton Myers
Start Time: 2021-03-01T17:21:40.239+0000
Duration: 22 min 59 sec
Commit: be9abfa

Test stats 🧪

Test	Results
Failed	0
Passed	7932
Skipped	5735
Total	13667

Trends 🧪

💚 Flaky test report

Tests succeeded.

Expand to view the summary

Test stats 🧪

Test	Results
Failed	0
Passed	7932
Skipped	5735
Total	13667

beniwohli · 2021-02-16T10:17:53Z

Interesting idea! So far, there is nothing in the agent that would make it impossible to have multiple agent instances running, so we'll have to make sure we don't break any relevant use cases with this.

I think this change would also allow us to tie instrumentation to the agent instance, making it possible to make the list of instrumentations configurable, which would be nice. Not sure how that would interact with the wrapper script that we plan to introduce, though.

Semi-related, looks like we forgot another 6.0 breaking change :( :

apm-agent-python/elasticapm/handlers/logging.py

Lines 60 to 68 in c1a9126

    
           else: 
        
               # In 6.0, this should raise a ValueError 
        
               warnings.warn( 
        
                   "LoggingHandler requires a Client instance. No Client was " 
        
                   "received. This will result in an error starting in v6.0 " 
        
                   "of the agent", 
        
                   PendingDeprecationWarning, 
        
               ) 
        
               self.client = Client(*args, **kwargs)

basepi · 2021-02-17T15:36:23Z

So far, there is nothing in the agent that would make it impossible to have multiple agent instances running, so we'll have to make sure we don't break any relevant use cases with this.

Do you have any use cases in mind? In the "multiple agent instances" case we end up with separate client instances anyway before this PR, right?

Not sure how that would interact with the wrapper script that we plan to introduce, though.

Luckily we get to write the wrapper script so I don't expect it to be a problem. :)

basepi · 2021-02-25T18:26:39Z

I realized that I don't really need to change every instance of self.client and app.client to get_client() -- but I did do a little cleanup in some places to use the new system (especially in Django land where we were already using globals to store the Client object).

I can't think of any other places that will be hit adversely by this change, so I think this is ready for review.

basepi · 2021-02-25T18:29:46Z

tests/contrib/django/django_tests.py

-def test_get_client(django_elasticapm_client):
-    with mock.patch.dict("os.environ", {"ELASTIC_APM_METRICS_INTERVAL": "0ms"}):
-        client2 = get_client("elasticapm.base.Client")
-        try:
-            assert get_client() is get_client()
-            assert client2.__class__ == Client
-        finally:
-            get_client().close()
-            client2.close()
-
-


Django's get_client() is only ever called with an argument here, in this test. Thus, I don't think we need the type-checking functionality that was in the old implementation. I just removed the test.

beniwohli

Lots of simplifications,I like!

DougDK · 2021-04-13T20:12:07Z

Interesting idea! So far, there is nothing in the agent that would make it impossible to have multiple agent instances running, so we'll have to make sure we don't break any relevant use cases with this.

I think this change would also allow us to tie instrumentation to the agent instance, making it possible to make the list of instrumentations configurable, which would be nice. Not sure how that would interact with the wrapper script that we plan to introduce, though.

Semi-related, looks like we forgot another 6.0 breaking change :( :

apm-agent-python/elasticapm/handlers/logging.py

Lines 60 to 68 in c1a9126

else:

# In 6.0, this should raise a ValueError

warnings.warn(

"LoggingHandler requires a Client instance. No Client was "

"received. This will result in an error starting in v6.0 "

"of the agent",

PendingDeprecationWarning,

)

self.client = Client(*args, **kwargs)

It looks like there's a use case that this would break. I create an issue for it to investigate a possible bug.
Issue 1098

* Make Client object globally available * Remove global client object on Client.close() * Fix django's get_client to use elasticapm.get_client * Clean up more client creation * CHANGELOG

github-actions bot added the agent-python label Feb 10, 2021

basepi added 5 commits February 25, 2021 10:26

Make Client object globally available

7531a29

Remove global client object on Client.close()

28072e0

Fix django's get_client to use elasticapm.get_client

e8ae522

Clean up more client creation

4500e16

CHANGELOG

ebebeaa

basepi force-pushed the globalclient branch from cd2e3ab to ebebeaa Compare February 25, 2021 18:25

basepi marked this pull request as ready for review February 25, 2021 18:25

basepi commented Feb 25, 2021

View reviewed changes

basepi requested a review from beniwohli February 25, 2021 18:30

Merge branch 'master' into globalclient

be9abfa

beniwohli approved these changes Mar 1, 2021

View reviewed changes

basepi merged commit 74fe1e8 into elastic:master Mar 1, 2021

basepi changed the title ~~[WIP] Make Client object globally available~~ Make Client object globally available Mar 10, 2021

basepi mentioned this pull request Mar 10, 2021

Simplify client fetching in django.handlers.LoggingHandler #1065

Merged

DougDK mentioned this pull request Apr 13, 2021

AttributeError: 'NoneType' object has no attribute 'config' in Flask Agent #1098

Closed

ccorbacho mentioned this pull request May 5, 2021

Intermittent Client AttributeError with Django integration #1093

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make Client object globally available #1043

Make Client object globally available #1043

basepi commented Feb 10, 2021

apmmachine commented Feb 10, 2021 •

edited

Loading

Build stats

Test stats 🧪

Trends 🧪

Test stats 🧪

beniwohli commented Feb 16, 2021

basepi commented Feb 17, 2021

basepi commented Feb 25, 2021

basepi Feb 25, 2021

beniwohli left a comment

DougDK commented Apr 13, 2021

Make Client object globally available #1043

Make Client object globally available #1043

Conversation

basepi commented Feb 10, 2021

What does this pull request do?

apmmachine commented Feb 10, 2021 • edited Loading

💚 Build Succeeded

Build stats

Test stats 🧪

Trends 🧪

💚 Flaky test report

Test stats 🧪

beniwohli commented Feb 16, 2021

basepi commented Feb 17, 2021

basepi commented Feb 25, 2021

basepi Feb 25, 2021

Choose a reason for hiding this comment

beniwohli left a comment

Choose a reason for hiding this comment

DougDK commented Apr 13, 2021

apmmachine commented Feb 10, 2021 •

edited

Loading